Skip to content

feat(prek): supporting prek as an alternative to pre-commit and switching to prek #1799

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
YazdanRa wants to merge 11 commits into
base: master
Choose a base branch
from
Open

feat(prek): supporting prek as an alternative to pre-commit and switching to prek #1799

YazdanRa wants to merge 11 commits into from
+80 −34

Conversation

@YazdanRa
Copy link
Contributor

@YazdanRa YazdanRa commented Jan 14, 2026

Description

Replacing pre-commit with prek and add support for prek in hooks

Checklist

Code Changes

  • Add test cases to all the changes you introduce
  • Run uv run poe all locally to ensure this change passes linter check and tests
  • Manually test the changes:
    • Verify the feature/bug fix works as expected in real-world scenarios
    • Test edge cases and error conditions
    • Ensure backward compatibility is maintained
    • Document any manual testing steps performed
  • Update the documentation for the changes

Documentation Changes

  • Run uv run poe doc locally to ensure the documentation pages renders correctly
  • Check and fix any broken links (internal or external) in the documentation

When running uv run poe doc, any broken internal documentation links will be reported in the console output like this:

INFO    -  Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'.

Expected Behavior

Faster pre commit checks and hook installation

Steps to Test This Pull Request

N/A

Additional Context

#1797

@codecov
Copy link

codecov bot commented Jan 14, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.96%. Comparing base (f6aef69) to head (f9b56d5).

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #1799   +/-   ##
=======================================
  Coverage   97.96%   97.96%           
=======================================
  Files          60       60           
  Lines        2648     2648           
=======================================
  Hits         2594     2594           
  Misses         54       54

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@YazdanRa YazdanRa force-pushed the feat/support-prek branch 2 times, most recently from 08c781c to 83e3832 Compare January 14, 2026 05:31
@YazdanRa YazdanRa marked this pull request as ready for review January 14, 2026 05:39
@YazdanRa
Copy link
Contributor Author

YazdanRa commented Jan 14, 2026

I should maybe add the pre-commit in the test dependency group and parameterize the tests to check for both. wdyt?

@bearomorphism
Copy link
Collaborator

bearomorphism commented Jan 14, 2026

I should maybe add the pre-commit in the test dependency group and parameterize the tests to check for both. wdyt?

sure, why not

bearomorphism
bearomorphism reviewed Jan 14, 2026
View reviewed changes
Copy link
Collaborator

@bearomorphism bearomorphism left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, some nits

@bearomorphism
Copy link
Collaborator

bearomorphism commented Jan 14, 2026

Thanks!

bearomorphism
bearomorphism reviewed Jan 14, 2026
View reviewed changes
@bearomorphism
Copy link
Collaborator

bearomorphism commented Jan 14, 2026

This looks great! Let's wait for other maintainer's input.

Lee-W
Lee-W approved these changes Jan 18, 2026
View reviewed changes
Copy link
Member

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One wording nit. I'm good with this idea

docs/tutorials/auto_check.md Outdated


!!! tip "Using pre-commit framework"
Replace `prek` with `pre-commit` in the steps below if you prefer that tool. The configuration format is similar.
Copy link
Member

@Lee-W Lee-W Jan 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I understand why this appears here 🤔 Might need some reworkding

Copy link
Contributor Author

@YazdanRa YazdanRa Jan 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking since the commands are the same, this tip can help users who rather using pre-commit to save some time instead of searching for pre-commit commands.

We can either remove it or maybe change it to something like:

Tip

If you use pre-commit instead of prek, you can run the same commands.
Simply replace prek with pre-commit in the steps below.

or

Tip

If you're already using pre-commit, the commands are identical.
Replace prek with pre-commit and follow the same steps.

wdyt?

Copy link
Member

@Lee-W Lee-W Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the first one :)

YazdanRa added 10 commits January 18, 2026 19:51
@YazdanRa
feat(prek): support 'prek' as an alternative to 'pre-commit' in proje…
cbb86e7 
…ct_info
@YazdanRa
build(prek): replace 'pre-commit' with 'prek' in project configuration
4d8cc8d
@YazdanRa
docs(auto_check): update installation instructions to include 'prek' …
76deb95 
…as an alternative to 'pre-commit'
@YazdanRa
test: brought back the pre-commit tests along with prek
aa05e17
@YazdanRa
docs(README): update badge to reflect support for 'prek' instead of '…
1f0d566 
…pre-commit'
@YazdanRa
refactor(project_info): enhance pre-commit check to support multiple …
77f0b6d 
…tools
@YazdanRa
docs(auto_check): update auto check installation by only keeping one …
8281e93 
…example
@YazdanRa
docs: update documentation to reflect 'prek' integration and improve …
c7d7b79 
…clarity
@YazdanRa
docs(auto_check): add tip for using pre-commit framework alongside prek
ee14124
@YazdanRa
docs: improve formatting and clarity for rendering
d2ab503
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Lee-W Lee-W Lee-W approved these changes

@bearomorphism bearomorphism bearomorphism left review comments

@woile woile Awaiting requested review from woile woile is a code owner

@noirbizarre noirbizarre Awaiting requested review from noirbizarre noirbizarre is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

pr-status: wait-for-review type: feature A new enhacement proposal

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@YazdanRa @bearomorphism @Lee-W